All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.media.j3d.Locale

java.lang.Object
   |
   +----javax.media.j3d.Locale

public class Locale

extends Object

Locale(VirtualUniverse)

Constructs and initializes a new high resolution Locale object located at (0, 0, 0).

Locale(VirtualUniverse, HiResCoord)

Constructs and initializes a new high resolution Locale object at the location specified by the HiResCoord argument.

Locale(VirtualUniverse, int[], int[], int[])

Constructs and initializes a new high resolution Locale object from the parameters provided.

addBranchGraph(BranchGroup)

Add a new branch graph rooted at BranchGroup to the list of branch graphs.

getAllBranchGraphs()

Get an Enumeration object of list of all branch graphs

getHiRes(HiResCoord)

Returns this node's HiResCoord.

getVirtualUniverse()

Retrieves the virtual universe that this Locale object is contained within.

numBranchGraphs()

Get number of branch graphs in this Locale.

pickAll(PickShape)

Returns an array referencing all the items that are pickable below this Locale that intersect with PickShape.

pickAllSorted(PickShape)

Returns a sorted array of references to all the Pickable items that intersect with the pickShape.

pickAny(PickShape)

Returns a reference to any item that is Pickable below this Locale which intersects with pickShape.

pickClosest(PickShape)

Returns a SceneGraphPath which references the pickable item which is closest to the origin of pickShape.

removeBranchGraph(BranchGroup)

Removes a branch graph rooted at BranchGroup from the list of branch graphs.

replaceBranchGraph(BranchGroup, BranchGroup)

Search for the branch graph rooted at oldGroup in the list of branch graphs and replace it the branch graph rooted at newGroup.

setHiRes(HiResCoord)

Sets the HiRes coordinate of this Locale to the location specified by the HiRes argument.

setHiRes(int[], int[], int[])

Sets the HiRes coordinate of this Locale to the location specified by the parameters provided.

 public Locale(VirtualUniverse universe)

Constructs and initializes a new high resolution Locale object located at (0, 0, 0).

Parameters:

universe - the virtual universe that will contain this Locale object

 public Locale(VirtualUniverse universe,
               int x[],
               int y[],
               int z[])

Constructs and initializes a new high resolution Locale object from the parameters provided.

Parameters:

universe - the virtual universe that will contain this Locale object

x - an eight element array specifying the x position

y - an eight element array specifying the y position

z - an eight element array specifying the z position

 public Locale(VirtualUniverse universe,
               HiResCoord hiRes)

Constructs and initializes a new high resolution Locale object at the location specified by the HiResCoord argument.

Parameters:

universe - the virtual universe that will contain this Locale object

hiRes - the HiRes coordinate to use in creating this Locale

 public VirtualUniverse getVirtualUniverse()

Retrieves the virtual universe that this Locale object is contained within.

Returns:

the virtual universe that this Locale object is contained within

 public void setHiRes(int x[],
                      int y[],
                      int z[])

Sets the HiRes coordinate of this Locale to the location specified by the parameters provided.

Parameters:

x - an eight element array specifying the x position

y - an eight element array specifying the y position

z - an eight element array specifying the z position

 public void setHiRes(HiResCoord hiRes)

Sets the HiRes coordinate of this Locale to the location specified by the HiRes argument.

Parameters:

hiRes - the HiRes coordinate specifying this node's new location

 public void getHiRes(HiResCoord hiRes)

Returns this node's HiResCoord.

Parameters:

hiRes - a HiResCoord object that will receive the HiRes coordinate of this Locale node

 public void addBranchGraph(BranchGroup branchGroup)

Add a new branch graph rooted at BranchGroup to the list of branch graphs.

Parameters:

branchGroup - root of the branch graph to be added

 public void removeBranchGraph(BranchGroup branchGroup)

Removes a branch graph rooted at BranchGroup from the list of branch graphs.

Parameters:

branchGroup - root of the branch graph to be removed

 public void replaceBranchGraph(BranchGroup oldGroup,
                                BranchGroup newGroup)

Search for the branch graph rooted at oldGroup in the list of branch graphs and replace it the branch graph rooted at newGroup.

Parameters:

oldGroup - root of the branch graph to be replaced

newGroup - root of the branch graph to be replaced with

 public int numBranchGraphs()

Get number of branch graphs in this Locale.

Returns:

number of branch graphs in this Locale.

 public Enumeration getAllBranchGraphs()

Get an Enumeration object of list of all branch graphs

Returns:

an Enumeration object of all branch graphs.

 public final SceneGraphPath[] pickAll(PickShape pickShape)

Returns an array referencing all the items that are pickable below this Locale that intersect with PickShape. The resultant array is unordered.

Parameters:

origin - The origin of the ray

direction - the direction of the ray

See Also:

SceneGraphPath, pickAll

 public final SceneGraphPath[] pickAllSorted(PickShape pickShape)

Returns a sorted array of references to all the Pickable items that intersect with the pickShape. Element [0] references the item closest to origin of PickShape successive array elements are further from the origin

See Also:

SceneGraphPath, pickAllSorted, PickShape

 public final SceneGraphPath pickClosest(PickShape pickShape)

Returns a SceneGraphPath which references the pickable item which is closest to the origin of pickShape.

See Also:

SceneGraphPath, pickClosest, PickShape

 public final SceneGraphPath pickAny(PickShape pickShape)

Returns a reference to any item that is Pickable below this Locale which intersects with pickShape.

See Also:

SceneGraphPath, pickAny, PickShape

All Packages  Class Hierarchy  This Package  Previous  Next  Index